ResourceHandlerFunction.HeadMethodResource

java.lang.Object
- org.springframework.web.reactive.function.server.ResourceHandlerFunction.HeadMethodResource

All Implemented Interfaces:: InputStreamSource, Resource

Enclosing class:: ResourceHandlerFunction

private static class ResourceHandlerFunction.HeadMethodResource
extends java.lang.Object
implements Resource

Field Summary

Fields
Modifier and Type Field and Description

private Resource delegate

private static byte[] EMPTY

Fields
Modifier and Type	Field and Description
`private Resource`	`delegate`
`private static byte[]`	`EMPTY`

Constructor Summary

Constructors
Constructor and Description

HeadMethodResource(Resource delegate)

Constructors
Constructor and Description
`HeadMethodResource(Resource delegate)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`contentLength()` Determine the content length for this resource.
`Resource`	`createRelative(java.lang.String relativePath)` Create a resource relative to this resource.
`boolean`	`exists()` Determine whether this resource actually exists in physical form.
`java.lang.String`	`getDescription()` Return a description for this resource, to be used for error output when working with the resource.
`java.io.File`	`getFile()` Return a File handle for this resource.
`java.lang.String`	`getFilename()` Determine a filename for this resource, i.e.
`java.io.InputStream`	`getInputStream()` Return an `InputStream` for the content of an underlying resource.
`java.net.URI`	`getURI()` Return a URI handle for this resource.
`java.net.URL`	`getURL()` Return a URL handle for this resource.
`long`	`lastModified()` Determine the last-modified timestamp for this resource.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.core.io.Resource
isFile, isOpen, isReadable, readableChannel

- Field Detail
  - EMPTY
```
private static final byte[] EMPTY
```
  - delegate
```
private final Resource delegate
```
- Constructor Detail
  - HeadMethodResource
```
public HeadMethodResource(Resource delegate)
```
- Method Detail
  - getInputStream
```
public java.io.InputStream getInputStream()
                                   throws java.io.IOException
```
    Description copied from interface: InputStreamSource
    
    Return an InputStream for the content of an underlying resource.
    It is expected that each call creates a fresh stream.
    This requirement is particularly important when you consider an API such as JavaMail, which needs to be able to read the stream multiple times when creating mail attachments. For such a use case, it is required that each getInputStream() call returns a fresh stream.
    
    Specified by:
    
    getInputStream in interface InputStreamSource
    
    Returns:
    
    the input stream for the underlying resource (must not be null)
    
    Throws:
    
    java.io.FileNotFoundException - if the underlying resource doesn't exist
    
    java.io.IOException - if the content stream could not be opened
  - exists
```
public boolean exists()
```
    Description copied from interface: Resource
    
    Determine whether this resource actually exists in physical form.
    This method performs a definitive existence check, whereas the existence of a Resource handle only guarantees a valid descriptor handle.
    
    Specified by:
    
    exists in interface Resource
  - getURL
```
public java.net.URL getURL()
                    throws java.io.IOException
```
    Description copied from interface: Resource
    
    Return a URL handle for this resource.
    
    Specified by:
    
    getURL in interface Resource
    
    Throws:
    
    java.io.IOException - if the resource cannot be resolved as URL, i.e. if the resource is not available as descriptor
  - getURI
```
public java.net.URI getURI()
                    throws java.io.IOException
```
    Description copied from interface: Resource
    
    Return a URI handle for this resource.
    
    Specified by:
    
    getURI in interface Resource
    
    Throws:
    
    java.io.IOException - if the resource cannot be resolved as URI, i.e. if the resource is not available as descriptor
  - getFile
```
public java.io.File getFile()
                     throws java.io.IOException
```
    Description copied from interface: Resource
    
    Return a File handle for this resource.
    
    Specified by:
    
    getFile in interface Resource
    
    Throws:
    
    java.io.FileNotFoundException - if the resource cannot be resolved as absolute file path, i.e. if the resource is not available in a file system
    
    java.io.IOException - in case of general resolution/reading failures
    
    See Also:
    
    InputStreamSource.getInputStream()
  - contentLength
```
public long contentLength()
                   throws java.io.IOException
```
    Description copied from interface: Resource
    
    Determine the content length for this resource.
    
    Specified by:
    
    contentLength in interface Resource
    
    Throws:
    
    java.io.IOException - if the resource cannot be resolved (in the file system or as some other known physical resource type)
  - lastModified
```
public long lastModified()
                  throws java.io.IOException
```
    Description copied from interface: Resource
    
    Determine the last-modified timestamp for this resource.
    
    Specified by:
    
    lastModified in interface Resource
    
    Throws:
    
    java.io.IOException - if the resource cannot be resolved (in the file system or as some other known physical resource type)
  - createRelative
```
public Resource createRelative(java.lang.String relativePath)
                        throws java.io.IOException
```
    Description copied from interface: Resource
    
    Create a resource relative to this resource.
    
    Specified by:
    
    createRelative in interface Resource
    
    Parameters:
    
    relativePath - the relative path (relative to this resource)
    
    Returns:
    
    the resource handle for the relative resource
    
    Throws:
    
    java.io.IOException - if the relative resource cannot be determined
  - getFilename
```
@Nullable
public java.lang.String getFilename()
```
    Description copied from interface: Resource
    
    Determine a filename for this resource, i.e. typically the last part of the path: for example, "myfile.txt".
    Returns null if this type of resource does not have a filename.
    
    Specified by:
    
    getFilename in interface Resource
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: Resource
    
    Return a description for this resource, to be used for error output when working with the resource.
    Implementations are also encouraged to return this value from their toString method.
    
    Specified by:
    
    getDescription in interface Resource
    
    See Also:
    
    Object.toString()

Class ResourceHandlerFunction.HeadMethodResource

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.core.io.Resource

Field Detail

EMPTY

delegate

Constructor Detail

HeadMethodResource

Method Detail

getInputStream

exists

getURL

getURI

getFile

contentLength

lastModified

createRelative

getFilename

getDescription